Add non-Path files support (for example Traversable) and open files using Path.open method #724
Conversation
|
Since you're already using |
|
mahenzon
changed the title
|
I've added tests for Traversable type to show the usecase. |
There was a problem hiding this comment.
Pull request overview
This PR improves file handling in pydantic-settings by switching from the built-in open() function to using the .open() method on path-like objects. This change aims to add support for non-filesystem path types like Traversable from importlib.resources, enabling configuration files to be loaded from packages and archives.
Key Changes:
- Modified file opening in JSON, YAML, and TOML config sources to use
path.open()instead ofopen(path) - Updated
_read_files()logic inConfigFileSourceMixinto handle path-like objects more flexibly - Added test for Traversable support using
importlib.resources
Reviewed changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| pydantic_settings/sources/providers/json.py | Changed to use file_path.open() for opening JSON files |
| pydantic_settings/sources/providers/yaml.py | Changed to use file_path.open() for opening YAML files |
| pydantic_settings/sources/providers/toml.py | Changed to use file_path.open() for opening TOML files |
| pydantic_settings/sources/base.py | Modified _read_files() to handle non-Path objects by conditionally converting strings and applying expanduser() only to Path objects |
| tests/test_source_json.py | Added test_traversable_support() to verify Traversable objects can be used as configuration file sources |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
|
Thanks @mahenzon |
3 participants
Open files (JSON, TOML, YAML) using
file_path.open()instead ofopen(file_path).Not only this is more suitable way, this change also adds support for passing types other than
pathlib.Pathandstr, for exampleTraversableand some others, that don't have real path to file, but allow to be opened using the.open()method.